Restructure the documentation #177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
swapnilgm
requested review from
georgekuruvillak and
shreyas-s-rao
as code owners
gardener-robot-ci-1
added
the
reviewed/ok-to-test
swapnilgm
force-pushed
the
restructure-documentation
branch
from
15ea92f to
384b65e
Compare
swapnilgm
force-pushed
the
restructure-documentation
branch
from
384b65e to
52203f2
Compare
gardener-robot-ci-1
added
needs/ok-to-test
|
@shreyas-s-rao I updated the PR. PTAL. |
Signed-off-by: Swapnil Mhamane <[email protected]>
swapnilgm
force-pushed
the
restructure-documentation
branch
from
3695810 to
da3aa82
Compare
shreyas-s-rao
requested changes
Jul 31, 2019
There was a problem hiding this comment.
@swapnilgm Thanks for the excellent and much-required PR! Thanks for the updating the docs as well. I have suggested a couple of changes in the CI scripts as well as a few vocabulary changes for the docs. Please address them. Thanks.
.ci/unit_test
Outdated
| export GOBIN="${SOURCE_PATH}/tmp/bin" | ||
| export PATH="${GOBIN}:${PATH}" | ||
| fi | ||
| cd "${SOURCE_PATH}" | ||
|
|
||
| # Install Ginkgo (test framework) to be able to execute the tests. | ||
| go get -u github.com/onsi/ginkgo/ginkgo |
There was a problem hiding this comment.
Suggested change
| go get -u github.com/onsi/ginkgo/ginkgo | |
| GO111MODULE=off go get -u github.com/onsi/ginkgo/ginkgo |
swapnilgm
force-pushed
the
restructure-documentation
branch
2 times, most recently
from
c03f75c to
98158cf
Compare
|
thanks you for detailed review. I have addressed comments. PTAL. |
shreyas-s-rao
requested changes
Aug 6, 2019
There was a problem hiding this comment.
@swapnilgm Thanks for making the requested changes. I've suggested just a few more changes. Please address them.
.ci/integration_test:L72,L48: s/etcbrctl/etcdbrctl/g
.ci/integration_test:L74: Add GO111MODULE=ON to go build command
doc/proposals/design.md:L42,L79: (images/_____) -> (../images/_____)
.ci/integration_test
Outdated
| @@ -27,25 +27,12 @@ VCS="github.com" | |||
| ORGANIZATION="gardener" | |||
| PROJECT="etcd-backup-restore" | |||
| REPOSITORY=${VCS}/${ORGANIZATION}/${PROJECT} | |||
| VERSION_FILE="$(readlink -f "${SOURCE_PATH}/VERSION")" | |||
| VERSION_FILE="$(readlink -f "${SOURCE_PATH}/VERSION")" | |||
There was a problem hiding this comment.
Suggested change
| VERSION_FILE="$(readlink -f "${SOURCE_PATH}/VERSION")" | |
| VERSION_FILE="$(readlink -f "${SOURCE_PATH}/VERSION")" |
| ### Updating dependencies | ||
|
|
||
| The `Makefile` contains a rule called `revendor` which performs `go mod vendor` and `go mod tidy`. | ||
| * `go mod vendor` resets the main module's vendor directory to include all packages needed to build and test all the main module's packages. |
There was a problem hiding this comment.
Suggested change
| * `go mod vendor` resets the main module's vendor directory to include all packages needed to build and test all the main module's packages. | |
| * `go mod vendor` resets the main module's vendor directory to include all packages needed to build and test all the main module's packages. It does not include test code for vendored packages. |
swapnilgm
force-pushed
the
restructure-documentation
branch
from
98158cf to
c729979
Compare
|
Done |
shreyas-s-rao
added
reviewed/ok-to-test
gardener-robot-ci-1
added
needs/ok-to-test
Co-Authored-By: Shreyas Rao <[email protected]> Signed-off-by: Swapnil Mhamane <[email protected]>
swapnilgm
force-pushed
the
restructure-documentation
branch
from
c729979 to
f620df1
Compare
shreyas-s-rao
added
reviewed/ok-to-test
gardener-robot-ci-1
added
needs/ok-to-test
shreyas-s-rao
added
area/documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Swapnil Mhamane [email protected]
What this PR does / why we need it:
Restructure the documentation, with some minor updates regrading go module for dependency management.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Release note: